Saga<'TEvent, 'TSagaData, 'TState>Type
PackageFCQRS
C#-friendly abstract base for a saga. A concrete saga supplies InitialData,
SagaName, Originator (the aggregate it starts from), HandleEvent and
ApplySideEffects; the base provides the wiring (Init/Factory) and the small
transition DSL. Designed to be subclassed from C#.
Specification
Kind
Type
Members
16
Examples
0
``.ctor``Signature
Saga()
ApplySideEffectsSignature
this.ApplySideEffects
FactorySignature
this.Factory
FactorySignature
this.Factory
HandleEventSignature
this.HandleEvent
Summary
| Name | Signature | Synopsis |
|---|---|---|
| ``.ctor`` | Saga() | No description available. |
| ApplySideEffects | this.ApplySideEffects | No description available. |
| Factory | this.Factory | The factory the saga-starter spawns instances from. |
| Factory | this.Factory | The factory the saga-starter spawns instances from, with an explicit policy. |
| HandleEvent | this.HandleEvent | No description available. |
| Init | this.Init | Register the saga; calling this IS the registration. |
| Init | this.Init | Register the saga with an explicit (already-resolved) snapshot policy. |
| SnapshotPolicy | this.SnapshotPolicy | Per-saga snapshot cadence. |
| SagaName | this.SagaName | No description available. |
| InitialData | this.InitialData | No description available. |
| Originator | this.Originator | No description available. |
| NextState | Saga.NextState(next) | No description available. |
| StateChanged | Saga.StateChanged(next) | Transition and event DSL over TState. |
| Stay | Saga.Stay() | No description available. |
| StopSaga | Saga.StopSaga() | No description available. |
| Unhandled | Saga.Unhandled() | No description available. |
Parameters
| Name | Type | Description |
|---|---|---|
| arg0 | SagaState<'TSagaData, 'TState> | |
| arg1 | bool |
Returns
SagaSideEffectResult<'TState>
The factory the saga-starter spawns instances from.
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor |
Returns
AggregateFactory
The factory the saga-starter spawns instances from, with an explicit policy.
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor | |
| snapshotPolicy | SnapshotPolicy |
Returns
AggregateFactory
Parameters
| Name | Type | Description |
|---|---|---|
| arg0 | obj | |
| arg1 | SagaState<'TSagaData, 'TState option> |
Returns
EventAction<'TState>
Register the saga; calling this IS the registration.
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor |
Returns
EntityFac<obj>
Register the saga with an explicit (already-resolved) snapshot policy.
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor | |
| snapshotPolicy | SnapshotPolicy |
Returns
EntityFac<obj>
Per-saga snapshot cadence. Override to use Every(n) or NoSnapshots;
the default falls back to config:akka:persistence:snapshot-version-count (or 30).
Returns
SnapshotPolicy
Parameters
| Name | Type | Description |
|---|---|---|
| next | 'TState |
Returns
SagaTransition<'TState>
Transition and event DSL over TState.
Parameters
| Name | Type | Description |
|---|---|---|
| next | 'TState |
Returns
EventAction<'TState>